home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / spbsv.z / spbsv
Encoding:
Text File  |  2002-10-03  |  5.7 KB  |  199 lines

  1.  
  2.  
  3.  
  4. SSSSPPPPBBBBSSSSVVVV((((3333SSSS))))                                                            SSSSPPPPBBBBSSSSVVVV((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SPBSV - compute the solution to a real system of linear equations A * X =
  10.      B,
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE SPBSV( UPLO, N, KD, NRHS, AB, LDAB, B, LDB, INFO )
  14.  
  15.          CHARACTER     UPLO
  16.  
  17.          INTEGER       INFO, KD, LDAB, LDB, N, NRHS
  18.  
  19.          REAL          AB( LDAB, * ), B( LDB, * )
  20.  
  21. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  22.      These routines are part of the SCSL Scientific Library and can be loaded
  23.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  24.      directs the linker to use the multi-processor version of the library.
  25.  
  26.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  27.      4 bytes (32 bits). Another version of SCSL is available in which integers
  28.      are 8 bytes (64 bits).  This version allows the user access to larger
  29.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  30.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  31.      only one of the two versions; 4-byte integer and 8-byte integer library
  32.      calls cannot be mixed.
  33.  
  34. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  35.      SPBSV computes the solution to a real system of linear equations A * X =
  36.      B, where A is an N-by-N symmetric positive definite band matrix and X and
  37.      B are N-by-NRHS matrices.
  38.  
  39.      The Cholesky decomposition is used to factor A as
  40.         A = U**T * U,  if UPLO = 'U', or
  41.         A = L * L**T,  if UPLO = 'L',
  42.      where U is an upper triangular band matrix, and L is a lower triangular
  43.      band matrix, with the same number of superdiagonals or subdiagonals as A.
  44.      The factored form of A is then used to solve the system of equations A *
  45.      X = B.
  46.  
  47.  
  48. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  49.      UPLO    (input) CHARACTER*1
  50.              = 'U':  Upper triangle of A is stored;
  51.              = 'L':  Lower triangle of A is stored.
  52.  
  53.      N       (input) INTEGER
  54.              The number of linear equations, i.e., the order of the matrix A.
  55.              N >= 0.
  56.  
  57.      KD      (input) INTEGER
  58.              The number of superdiagonals of the matrix A if UPLO = 'U', or
  59.              the number of subdiagonals if UPLO = 'L'.  KD >= 0.
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSPPPPBBBBSSSSVVVV((((3333SSSS))))                                                            SSSSPPPPBBBBSSSSVVVV((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      NRHS    (input) INTEGER
  75.              The number of right hand sides, i.e., the number of columns of
  76.              the matrix B.  NRHS >= 0.
  77.  
  78.      AB      (input/output) REAL array, dimension (LDAB,N)
  79.              On entry, the upper or lower triangle of the symmetric band
  80.              matrix A, stored in the first KD+1 rows of the array.  The j-th
  81.              column of A is stored in the j-th column of the array AB as
  82.              follows:  if UPLO = 'U', AB(KD+1+i-j,j) = A(i,j) for max(1,j-
  83.              KD)<=i<=j; if UPLO = 'L', AB(1+i-j,j)    = A(i,j) for
  84.              j<=i<=min(N,j+KD).  See below for further details.
  85.  
  86.              On exit, if INFO = 0, the triangular factor U or L from the
  87.              Cholesky factorization A = U**T*U or A = L*L**T of the band
  88.              matrix A, in the same storage format as A.
  89.  
  90.      LDAB    (input) INTEGER
  91.              The leading dimension of the array AB.  LDAB >= KD+1.
  92.  
  93.      B       (input/output) REAL array, dimension (LDB,NRHS)
  94.              On entry, the N-by-NRHS right hand side matrix B.  On exit, if
  95.              INFO = 0, the N-by-NRHS solution matrix X.
  96.  
  97.      LDB     (input) INTEGER
  98.              The leading dimension of the array B.  LDB >= max(1,N).
  99.  
  100.      INFO    (output) INTEGER
  101.              = 0:  successful exit
  102.              < 0:  if INFO = -i, the i-th argument had an illegal value
  103.              > 0:  if INFO = i, the leading minor of order i of A is not
  104.              positive definite, so the factorization could not be completed,
  105.              and the solution has not been computed.
  106.  
  107. FFFFUUUURRRRTTTTHHHHEEEERRRR DDDDEEEETTTTAAAAIIIILLLLSSSS
  108.      The band storage scheme is illustrated by the following example, when N =
  109.      6, KD = 2, and UPLO = 'U':
  110.  
  111.      On entry:                       On exit:
  112.  
  113.          *    *   a13  a24  a35  a46      *    *   u13  u24  u35  u46
  114.          *   a12  a23  a34  a45  a56      *   u12  u23  u34  u45  u56
  115.         a11  a22  a33  a44  a55  a66     u11  u22  u33  u44  u55  u66
  116.  
  117.      Similarly, if UPLO = 'L' the format of A is as follows:
  118.  
  119.      On entry:                       On exit:
  120.  
  121.         a11  a22  a33  a44  a55  a66     l11  l22  l33  l44  l55  l66
  122.         a21  a32  a43  a54  a65   *      l21  l32  l43  l54  l65   *
  123.         a31  a42  a53  a64   *    *      l31  l42  l53  l64   *    *
  124.  
  125.      Array elements marked * are not used by the routine.
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. SSSSPPPPBBBBSSSSVVVV((((3333SSSS))))                                                            SSSSPPPPBBBBSSSSVVVV((((3333SSSS))))
  137.  
  138.  
  139.  
  140. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  141.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  142.  
  143.      This man page is available only online.
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.